Skip to content

Milestone 3: Initial README Draft + Images Folder Setup#23

Merged
CaesarGhazi merged 3 commits intomainfrom
main_readme
Nov 18, 2025
Merged

Milestone 3: Initial README Draft + Images Folder Setup#23
CaesarGhazi merged 3 commits intomainfrom
main_readme

Conversation

@doctorbanu
Copy link
Copy Markdown
Collaborator


name: Initial README Draft + Images Folder Setup
about: Add Initial Main README Draft and Create readme_images Directory

Summary:
This PR introduces the initial draft of the project’s main README and sets
up the readme_images directory to store all image assets referenced in
the document. This provides a clear structure for adding visual elements
to the documentation and keeps the repo organized as we iterate.

What’s Included:
Added: Initial version of the main README (README.md)
Added: 'readme_images' folder for storing README visuals
Prepared placeholders for future sections like key findings

General Checks

  • the branch is up to date with main
  • the code works when pulled and run locally
  • All CI checks pass (or at least discussed)
  • all conflicts are resolved (if any)
  • PR has a descriptive title
  • PR has appropriate labels and milestones for easy identification
  • PR it is assigned to the owner
  • reviewers are assigned
  • the PR contributes only one focused change
  • It is in the appropriate column in the project board (if necessary)
  • has short and clear description
  • is linked to an issue (if it is related)
  • feedback is addressed (if any and if it is appropriate feedback.)

Markdown

  • the markdown source is formatted
  • spelling and grammar is correct in all text
  • The markdown looks correct when you preview the file
  • all links and images work

@doctorbanu doctorbanu added this to the milestone 3 milestone Nov 17, 2025
@doctorbanu doctorbanu self-assigned this Nov 17, 2025
@doctorbanu doctorbanu added the documentation Improvements or additions to documentation label Nov 17, 2025
Copy link
Copy Markdown
Collaborator

@CaesarGhazi CaesarGhazi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IT LOOKS AMAAAAZING!!!!

@CaesarGhazi CaesarGhazi merged commit 6f07957 into main Nov 18, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

milestone 3- Add initial main README draft and a readme_images Folder for main README images

2 participants